This function returns information about a subsetted region for a particular field. Because of differences in number type and geolocation mapping, a given region will give different values for the dimensions and size for various fields.
Note: Array ordering of variables used or returned by this routine changed in IDL 5.5. Programs written for versions of this routine prior to IDL 5.5 may need to be modified to work correctly with the current version.
Result = EOS_SW_REGIONINFO(swathID, regionID, fieldname, ntype, rank, dims, size)
Returns SUCCEED (0) if successful and FAIL (–1) otherwise.
Swath id (long) returned by EOS_SW_CREATE or EOS_SW_ATTACH.
Region id (long) returned by EOS_SW_DEFBOXREGION.
Field to subset (string).
A named variable that will contain the number type of field (long).
A named variable that will contain the rank of field (long).
A named variable that will contain the dimensions of subset region (long).
A named variable that will contain the size in bytes of subset region (long).
None
In this example, we retrieve information about the region defined in EOS_SW_DEFBOXREGION for the Spectra field:
status = EOS_SW_REGIONINFO(EOS_SW_id, regionID, "Spectra", $
ntype, rank, dims, size)
|
5.2 |
Introduced |